Now that we have all the code needed for our subsystem, we can build our project by running mvn install
[kabir ~/sourcecontrol/temp/archetype-test/acme-subsystem]
$mvn install
[INFO] Scanning for projects...
[...]
main:
[delete] Deleting: /Users/kabir/sourcecontrol/temp/archetype-test/acme-subsystem/null1004283288
[delete] Deleting directory /Users/kabir/sourcecontrol/temp/archetype-test/acme-subsystem/target/module
[copy] Copying 1 file to /Users/kabir/sourcecontrol/temp/archetype-test/acme-subsystem/target/module/com/acme/corp/tracker/main
[copy] Copying 1 file to /Users/kabir/sourcecontrol/temp/archetype-test/acme-subsystem/target/module/com/acme/corp/tracker/main
[echo] Module com.acme.corp.tracker has been created in the target/module directory. Copy to your JBoss AS 7 installation.
[INFO] Executed tasks
[INFO]
[INFO] --- maven-install-plugin:2.3.1:install (default-install) @ acme-subsystem ---
[INFO] Installing /Users/kabir/sourcecontrol/temp/archetype-test/acme-subsystem/target/acme-subsystem.jar to /Users/kabir/.m2/repository/com/acme/corp/acme-subsystem/1.0-SNAPSHOT/acme-subsystem-1.0-SNAPSHOT.jar
[INFO] Installing /Users/kabir/sourcecontrol/temp/archetype-test/acme-subsystem/pom.xml to /Users/kabir/.m2/repository/com/acme/corp/acme-subsystem/1.0-SNAPSHOT/acme-subsystem-1.0-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.851s
[INFO] Finished at: Mon Jul 11 23:24:58 BST 2011
[INFO] Final Memory: 7M/81M
[INFO] ------------------------------------------------------------------------
This will have built our project and assembled a module for us that can be used for installing it into WildFly 8. If you go to the target/module folder where you built the project you will see the module
$ls target/module/com/acme/corp/tracker/main/
acme-subsystem.jar module.xml
The module.xml comes from src/main/resources/module/main/module.xml and is used to define your module. It says that it contains the acme-subsystem.jar:
<module xmlns="urn:jboss:module:1.0" name="com.acme.corp.tracker">
<resources>
<resource-root path="acme-subsystem.jar"/>
</resources>
And has a default set of dependencies needed by every subsystem created. If your subsystem requires additional module dependencies you can add them here before building and installing.
<dependencies>
<module name="javax.api"/>
<module name="org.jboss.staxmapper"/>
<module name="org.jboss.as.controller"/>
<module name="org.jboss.as.server"/>
<module name="org.jboss.modules"/>
<module name="org.jboss.msc"/>
<module name="org.jboss.logging"/>
<module name="org.jboss.vfs"/>
</dependencies>
</module>
Note that the name of the module corresponds to the directory structure containing it. Now copy the target/module/com/acme/corp/tracker/main/ directory and its contents to $WFLY/modules/com/acme/corp/tracker/main/ (where $WFLY is the root of your WildFly install).
Next we need to modify $WFLY/standalone/configuration/standalone.xml. First we need to add our new module to the <extensions> section:
<extensions>
...
<extension module="org.jboss.as.weld"/>
<extension module="com.acme.corp.tracker"/>
</extensions>
And then we have to add our subsystem to the <profile> section:
<profile>
...
<subsystem xmlns="urn:com.acme.corp.tracker:1.0">
<deployment-types>
<deployment-type suffix="sar" tick="10000"/>
<deployment-type suffix="war" tick="10000"/>
</deployment-types>
</subsystem>
...
</profile>
Adding this to a managed domain works exactly the same apart from in this case you need to modify $AS7/domain/configuration/domain.xml.
Now start up WildFly 8 by running $WFLY/bin/standalone.sh and you should see messages like these after the server has started, which means our subsystem has been added and our TrackerService is working:
15:27:33,838 INFO [org.jboss.as] (Controller Boot Thread) JBoss AS 7.0.0.Final "Lightning" started in 2861ms - Started 94 of 149 services (55 services are passive or on-demand)
15:27:42,966 INFO [stdout] (Thread-8) Current deployments deployed while sar tracking active:
15:27:42,966 INFO [stdout] (Thread-8) []
15:27:42,967 INFO [stdout] (Thread-8) Cool: 0
15:27:42,967 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:27:42,967 INFO [stdout] (Thread-9) []
15:27:42,967 INFO [stdout] (Thread-9) Cool: 0
15:27:52,967 INFO [stdout] (Thread-8) Current deployments deployed while sar tracking active:
15:27:52,967 INFO [stdout] (Thread-8) []
15:27:52,967 INFO [stdout] (Thread-8) Cool: 0
If you run the command line interface you can execute some commands to see more about the subsystem. For example
[standalone@localhost:9999 /] /subsystem=tracker/:read-resource-description(recursive=true, operations=true)
will return a lot of information, including what we provided in the DescriptionProviders we created to document our subsystem.
To see the current subsystem state you can execute
[standalone@localhost:9999 /] /subsystem=tracker/:read-resource(recursive=true)
{
"outcome" => "success",
"result" => {"type" => {
"war" => {"tick" => 10000L},
"sar" => {"tick" => 10000L}
}}
}
We can remove both the deployment types which removes them from the model:
[standalone@localhost:9999 /] /subsystem=tracker/type=sar:remove
{"outcome" => "success"}
[standalone@localhost:9999 /] /subsystem=tracker/type=war:remove
{"outcome" => "success"}
[standalone@localhost:9999 /] /subsystem=tracker/:read-resource(recursive=true)
{
"outcome" => "success",
"result" => {"type" => undefined}
}
You should now see the output from the TrackerService instances having stopped.
Now, let's add the war tracker again:
[standalone@localhost:9999 /] /subsystem=tracker/type=war:add
{"outcome" => "success"}
[standalone@localhost:9999 /] /subsystem=tracker/:read-resource(recursive=true)
{
"outcome" => "success",
"result" => {"type" => {"war" => {"tick" => 10000L}}}
}
and the WildFly 8 console should show the messages coming from the war TrackerService again.
Now let us deploy something. You can find two maven projects for test wars already built at test1.zip and test2.zip. If you download them and extract them to /Downloads/test1 and /Downloads/test2, you can see that /Downloads/test1/target/test1.war contains a META-INF/cool.txt while /Downloads/test2/target/test2.war does not contain that file. From CLI deploy test1.war first:
[standalone@localhost:9999 /] deploy ~/Downloads/test1/target/test1.war
'test1.war' deployed successfully.
And you should now see the output from the war TrackerService list the deployments:
15:35:03,712 INFO [org.jboss.as.server.deployment] (MSC service thread 1-2) Starting deployment of "test1.war"
15:35:03,988 INFO [org.jboss.web] (MSC service thread 1-1) registering web context: /test1
15:35:03,996 INFO [org.jboss.as.server.controller] (pool-2-thread-9) Deployed "test1.war"
15:35:13,056 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:35:13,056 INFO [stdout] (Thread-9) [test1.war]
15:35:13,057 INFO [stdout] (Thread-9) Cool: 1
So our test1.war got picked up as a 'cool' deployment. Now if we deploy test2.war
[standalone@localhost:9999 /] deploy ~/sourcecontrol/temp/archetype-test/test2/target/test2.war
'test2.war' deployed successfully.
You will see that deployment get picked up as well but since there is no META-INF/cool.txt it is not marked as a 'cool' deployment:
15:37:05,634 INFO [org.jboss.as.server.deployment] (MSC service thread 1-4) Starting deployment of "test2.war"
15:37:05,699 INFO [org.jboss.web] (MSC service thread 1-1) registering web context: /test2
15:37:05,982 INFO [org.jboss.as.server.controller] (pool-2-thread-15) Deployed "test2.war"
15:37:13,075 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:37:13,075 INFO [stdout] (Thread-9) [test1.war, test2.war]
15:37:13,076 INFO [stdout] (Thread-9) Cool: 1
An undeploy
[standalone@localhost:9999 /] undeploy test1.war
Successfully undeployed test1.war.
is also reflected in the TrackerService output:
15:38:47,901 INFO [org.jboss.as.server.controller] (pool-2-thread-21) Undeployed "test1.war"
15:38:47,934 INFO [org.jboss.as.server.deployment] (MSC service thread 1-3) Stopped deployment test1.war in 40ms
15:38:53,091 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:38:53,092 INFO [stdout] (Thread-9) [test2.war]
15:38:53,092 INFO [stdout] (Thread-9) Cool: 0
Finally, we registered a write attribute handler for the tick property of the type so we can change the frequency
[standalone@localhost:9999 /] /subsystem=tracker/type=war:write-attribute(name=tick,value=1000)
{"outcome" => "success"}
You should now see the output from the TrackerService happen every second
15:39:43,100 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:39:43,100 INFO [stdout] (Thread-9) [test2.war]
15:39:43,101 INFO [stdout] (Thread-9) Cool: 0
15:39:44,101 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:39:44,102 INFO [stdout] (Thread-9) [test2.war]
15:39:44,105 INFO [stdout] (Thread-9) Cool: 0
15:39:45,106 INFO [stdout] (Thread-9) Current deployments deployed while war tracking active:
15:39:45,106 INFO [stdout] (Thread-9) [test2.war]
If you open $WFLY/standalone/configuration/standalone.xml you can see that our subsystem entry reflects the current state of the subsystem:
<subsystem xmlns="urn:com.acme.corp.tracker:1.0">
<deployment-types>
<deployment-type suffix="war" tick="1000"/>
</deployment-types>
</subsystem>